Skip to main content
Feedback

How to Connect to Cloud API Management

API Gateways created in Cloud API Management can be discovered in API Control Plane. In API Control Plane, these agentless Gateways are considered Boomi-managed and have (Managed) appended to their Gateway name.

note

The ability to provision, register, and manage Boomi Cloud API Management Gateways was introduced in March 2026. If you have existing Cloud API Management standalone agents in API Control Plane and discover Boomi-managed agents, you can keep your standalone agents so that everything appears in API Control Plane. If you delete the standalone agent, subscriptions/keys will be hidden in API Control Plane, but they will continue to work.

Prerequisites

To proceed, you will need the following:

  • Your Boomi account must be provisioned to use the API Control Plane.

  • An account on Cloud API Management with at least one API.

  • Developer API Key for executing Mashery APIs: V2 + V3 (Basic) APIs. You can create the key by logging in to https://developer.mashery.com/ with your service user credentials. After you create the key, contact Boomi Support to increase the quota to 10 QPS. The agent requires a higher quota allowance than is provided when the API Key is created for your service user.

Cloud API Management Discovery and Deployment

Discovering API definitions from Cloud API Management allows you to:

  • Create API Products in API Control Plane
  • Create and assign plans for API Product subscriptions
  • Subscribe to and consume the APIs through API Control Plane Applications
  • Publish Applications from API Control Plane into Cloud API Management
note

API Control Plane uses the API specification that exists in Cloud API Management. If you make changes to the API via the UI, you must also make that change in the API specification document.

Use this guide for terminology mapping between API Control Plane and Cloud API Management:

Control Plane Entity NameCloud API Management Name
APIAPI Definition (and specs)
ApplicationApplication
API ProductPackage
PlanPlan
note

This process assumes that you have created API Definitions in Cloud API Management.

Discover APIs

In API Control Plane Environments, select Discover. API Definitions from Cloud API Management display in the APIs list.

Create API Product

  1. In APIs>API Products, select Assign to API Product.

  2. Assign plans to the API product. In API Products > Plans, find or create the plan(s) and select Assign.

  3. Subscribe to the API Product. In API Products > Subscriptions, find the plan name and select Subscribe.

  4. Create an Application for the API Product. In Applications, select Create New Application.

Subscribe

  1. Subscribe to the Application. In Applications > Subscriptions, select Create New Subscription and select the API product name.
  2. Subscriptions must be approved by an Administrator. In Home, find the approval request and select Approve.

After approving, a package and package key are created in Cloud API Management for the API Product. In Cloud API Management, the Package and Plan are part of the package key and the API Package name is the API Product created in the Control Plane.

note

If you change the plan in Control Plane, the existing package key is deleted in Cloud API Management and a new one is created.

On this Page